home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfcomtrv.zip / SFCOMTRV.DOC < prev    next >
Text File  |  1990-09-10  |  17KB  |  394 lines
  1.                                 SFCOMTRV
  2.                               Release  2.5
  3.                            by Bernard King of
  4.                              NEWS CARRIER BBS
  5.  
  6.    INTRODUCTION
  7.    ------------
  8.  
  9.       SFCOMTRV is a fast paced trivia game designed to run as a door feature
  10.    within the SPITFIRE Bulletin Board System. The data file contains approx-
  11.    imately 310 assorted trivia  questions based on the design and  operation
  12.    of computers. During execution this file is randomly accessed  displaying
  13.    the questions to the screen.
  14.       With each display, four multiple choice options are provided from which
  15.    the player has ten seconds to read and respond with the number correspond-
  16.    ing to the answer they wish to select. The file is then scrolled after
  17.    the selection is entered or upon time out.
  18.  
  19.    SFCOMTRV SETUP
  20.    --------------
  21.  
  22.       To set up SFCOMTRV to be executed as a door, it is recommended that
  23.    a separate directory be created. For example if the directory DOORA was
  24.    created for use with SFCOMTRV, then copy the following files to that
  25.    directory:
  26.  
  27.    SFCOMTRV.EXE    The actual game program.
  28.  
  29.    SFCOMTRV.DAT    The data file containing the trivia questions.
  30.  
  31.    SFCOMTRV.TOP    This is a listing of the top ten players.  SFCOMTRV.EXE
  32.                    will create this file if it is not found.
  33.  
  34.    SFCOMTRV.LMT    This file contains the time limit set for each security
  35.                    level on your system.
  36.  
  37.    Now use your favourite text editor to edit the SF.BAT file as illustrated
  38.    below:
  39.  
  40.    :DOOR_A
  41.    COPY SFDOORS.DAT C:\SF\DOORA
  42.    SFCOMTRV /D /P C:\SF\DISPLAY\DORBUL1
  43.    ERASE SFDOORS.DAT
  44.    GOTO LOOP
  45.    :DOOR_B
  46.  
  47.    You will notice from the example above that the commands to execute
  48.    SFCOMTRV are placed between :DOOR_A and GOTO LOOP command lines. The
  49.    commands are entered in place of the "Rem place program name here."
  50.  
  51.    COMMAND LINE PARAMETERS
  52.    -----------------------
  53.  
  54.        /P - Specifies the drive, path, filename and extension of the
  55.             high score bulletin.
  56.  
  57.        /D - Specifies the delay time (in seconds) that the user is
  58.             allowed to answer the question before it times out. If
  59.             not included the program will default to a  ten second
  60.             delay.
  61.  
  62.        /L - Allows local usage.
  63.  
  64.  
  65.    The following will briefly explain each of the commands which were
  66.    set up within SF.BAT file to run SFCOMTRV as a SPITFIRE Door program:
  67.  
  68.    Line: 1    Select the Door number under which SFCOMTRV will run.
  69.  
  70.    Line: 2    Copy SFDOORS.DAT which is created automatically by SPITFIRE
  71.               to the directory where SFCOMTRV resides. This file contains
  72.               information about the user such as name and password. There-
  73.               fore, before executing the program it must be copied to the
  74.               directory in which SFCOMTRV will be running.
  75.  
  76.    Line: 3    Execute the game program SFCOMTRV from within the door. If
  77.               the optional parameters "/D" and "/P" are used  the program
  78.               will time out by the number (in seconds) set by the "/D(xx)"
  79.               and the dorbul(x) file will be written to the directory
  80.               specified by the "/P".
  81.  
  82.    Line: 4    Erase SFDOORS.DAT on termination of the game.
  83.  
  84.    Line: 5    Recall the BBS.
  85.  
  86.  
  87.    SFCOMTRV SETUP AS A SYSOP CONFIGURABLE COMMAND
  88.    ----------------------------------------------
  89.  
  90.       SPITFIRE has a sysop configurable command for the Main, Message
  91.    and File menus.  The sysop configurable command is executed through
  92.    a batch file which corresponds to the menu chosen. In other words,
  93.    SFMAIN.BAT runs the sysop configurable command from the Main Menu,
  94.    SFMESS.BAT runs the one from the Message Menu and SFFILE.BAT the
  95.    one from the File Menu.  The commands necessary to execute SFCOMTRV
  96.    can be set up in either one of the batch files mentioned above.
  97.  
  98.       The first thing you will need to establish is which of these menus
  99.    you wish to use to run SFCOMTRV.  For this purpose, let's assume that
  100.    it is going to be set up so it can be run from the Main Menu.  (It
  101.    should be noted that the set up procedure is the same regardless of
  102.    which Menu you plan to use.)
  103.  
  104.       Next, you will have to decide what you wish to name the command
  105.    option and establish what security level will be required for
  106.    users of your system to be able to access this option.  Once this
  107.    is determined  modify the SFMAIN.MNU file using your favorite text
  108.    editor, as long as it saves in ASCII format. (Refer to the SPITFIRE
  109.    manual for further documentation on this if needed. It should also 
  110.    be noted that if SFCOMTRV were being set up to run from the File
  111.    Menu, you will have to modify the SFFILE.MNU file or SFMSG.MNU if
  112.    the Message Menu is being used.)
  113.  
  114.       Examining the default SFMAIN.MNU file, you will notice the sysop
  115.    configurable command appears as:
  116.  
  117.         <K>............. Add Your Own,,1000,@
  118.  
  119.       Replace the command character <K> with the character of your choice
  120.    that will be used to select the option from the menu.  It is ASOLUTELY
  121.    IMPERATIVE that the Command Character must not duplicate an existing
  122.    Command Character for another menu option. Now include a brief descript-
  123.    ion of SFCOMTRV, two commas, the security level required to access this
  124.    feature, and another comma followed by the @. The @ must not be changed!
  125.    (For more detailed information on modifying your SFMAIN.MNU, SFMSG.MNU
  126.    or SFFILE.MNU refer to your SPITFIRE manual.)
  127.  
  128.        <K>.... Brief Program Description,,10,@
  129.  
  130.       Now you would modify the corresponding batch file, SFMAIN.BAT, so
  131.    that it can be executed from the Main Menu. Do this using your favorite
  132.    text editor, as long as it saves in ASCII format.  (Again, it should be
  133.    noted that if SFCOMTRV were being set up to run from either the File
  134.    Menu or the Message Menu, you will have to modify the SFFILE.BAT or
  135.    SFMESS.BAT respectively.
  136.  
  137.       Place the SFCOMTRV.EXE file in the directory from which it will be
  138.    executed. The program will create its own player score file, SFCOMTRV.TOP,
  139.    if it does not already exist.
  140.  
  141.       The commands set up in the SFMAIN.BAT file are very similar to
  142.    those used for executing the game through a door in the SF.BAT file.
  143.    For instance, if you were running SFCOMTRV from the main SPITFIRE
  144.    directory your SFMAIN.BAT file might look like this:
  145.  
  146.        ECHO OFF
  147.        BRK OFF
  148.        SFCOMTRV
  149.        BRK ON
  150.  
  151.       (BRK is not included in the SPITFIRE package because it is written
  152.    and copyrighted by Solid Systems, but can be downloaded from either
  153.    Buffalo Creek BBS, News Carrier BBS or many other systems around. BRK
  154.    is not required to run SFCOMTRV, however, it is recommended since it
  155.    will prevent a user from using the CTRL BRK command to terminate the
  156.    batch file, thus gaining access to your system at the DOS level.)
  157.  
  158.       If you wish to set SFCOMTRV up in a separate subdirectory from
  159.    SPITFIRE, for instance, a subdirectory named SFCOMTRV, your batch
  160.    file might look like this.
  161.  
  162.        ECHO OFF
  163.        BRK OFF
  164.        COPY SFMAIN.DAT \SF\SFCOMTRV
  165.        CD \SF\SFCOMTRV
  166.        SFCOMTRV /D /P C:\SF\DISPLAY\DORBUL1
  167.        ERASE SFMAIN.DAT
  168.        CD \SF
  169.        BRK ON
  170.  
  171.       When SFCOMTRV is executed, from either the door with the SF.BAT file
  172.    or from the sysop configurable command through a menu with the
  173.    corresponding batch file, it will first look for the SFMAIN.DAT file,
  174.    then the SFMESS.DAT file, then the SFFILE.DAT file and lastly the
  175.    SFDOORS.DAT file.  It will look for each of these files until it finds
  176.    it and the commands required for its execution.  If none of these
  177.    files are found, SFCOMTRV will halt its execution.
  178.  
  179.  
  180.    LOCAL PLAY OF SFCOMTRV
  181.    ----------------------
  182.  
  183.       It should also be noted that a Sysop can play SFCOMTRV locally by
  184.    entering the following command at the DOS prompt:
  185.  
  186.    C:> SFCOMTRV /L
  187.  
  188.  
  189.    DTE LOCK FEATURE
  190.    ----------------
  191.  
  192.       SFCOMTRV automatically detects if the DTE is locked at 19200 baud. If
  193.    SFCOMTRV detects that the DTE is locked, then SFCOMTRV opens the serial
  194.    port to the maximum baud rate of your system.  If SFCOMTRV does not
  195.    detect that the DTE is locked, then the serial port is opened to the
  196.    baud rate of the caller.
  197.  
  198.  
  199.    SYSOP FEATURES
  200.    --------------
  201.  
  202.       This door program contains several features which gives the Sysop
  203.    control over the game as it is being played on their BBS. First, a
  204.    status line is displayed on the BBS monitor that provides information
  205.    concerning the caller's name, baud rate and security level.
  206.  
  207.       A SFCOMTRV.LMT file has been incorporated which allows the sysop
  208.    to establish a time limit for door play according to the security
  209.    level the caller has on the system.  To modify the accompanying 
  210.    SFCOMTRV.LMT file, use your favorite text editor to represent the
  211.    various security levels you have available on your system, a comma
  212.    then the corresponding time you wish to allow for that particular
  213.    security level in minutes.  For instance, it might look like this:
  214.  
  215.    10,15
  216.    25,20
  217.    50,25
  218.    999,30
  219.  
  220.    Each security level should begin a new line and you should have a
  221.    setting for each security level you have available on your system.
  222.    If you do not have a time limit set for a particular security 
  223.    SFCOMTRV will default to the level 10 security level setting.
  224.  
  225.    
  226.    Function Keys
  227.    -------------
  228.  
  229.       Pressing the Shift Key and the F1 key simultaneously will
  230.    terminate game play of SFCOMTRV and return the caller back to the
  231.    BBS.  Pressing the Shift Key and the F9 key simultaneously will
  232.    terminate game play of SFCOMTRV and log the caller off of the BBS.
  233.    If the Shift Key and the F9 key are pressed together, logging the
  234.    caller off the BBS, SPITFIRE will recycle and return to the
  235.    SPITFIRE Ready For Caller Prompt.
  236.  
  237.       By specifying the optional parameter  /P on the command line, it
  238.    forces SFCOMTRV to write dorbul(x) in ansi and ascii to the directory
  239.    you select. These bulletin files can be viewed by the users through
  240.    your Doors bulletin menu.
  241.  
  242.       By using the optional parameter /D the Sysop can regulate the
  243.    delay time (in seconds) that is allowed for the answer to be
  244.    given after the question is displayed on the screen.
  245.  
  246.    Your command line would be as was mentioned before:
  247.  
  248.       SFCOMTRV /D /P C:\SF\DISPLAY\DORBUL1
  249.  
  250.    
  251.    NOTE: The /D, /P and /L command parameters can be used together in
  252.    ----  one command line and in any order.
  253.  
  254.  
  255.    SFCOMTRV EXECUTION
  256.    ------------------
  257.  
  258.    When first executed, SFCOMTRV will display a list of the Top Ten high
  259.    score players and the percentage of correct responses they acheived
  260.    while playing SFCOMTRV.  Initially, this will be a dummy listing with
  261.    ten lines that display:
  262.  
  263.       0%...............YOUR NAME COULD BE HERE
  264.  
  265.    However, as the game is played, this will fill with the name of the
  266.    players and their percentage ratings.
  267.  
  268.    NOTE: At least twenty questions must be attempted before SFCOMTRV will
  269.    ----  will figure the percentage rating for the player.
  270.  
  271.    To keep things interesting...the Sysop can erase the file which contains
  272.    the top ten listings SFCOMTRV.TOP on a routine basis to give additional
  273.    players a chance to have their name added to the list.
  274.  
  275.    As the top ten list is displayed, at the bottom of the screen  is a
  276.    question which prompts the user whether they want to have ANSI Graphics
  277.    (y/n)? available to them during game play.  If the user responds with a
  278.    y (for yes) the game will display in color and if the user responds with
  279.    a n (for no) the game will display in monochrome.
  280.  
  281.  
  282.    PLAYING SFCOMTRV
  283.    ----------------
  284.  
  285.       Immediately after pressing any key (other than <Q> for Quit) from
  286.    the Top Ten listing the game screen is displayed.  The screen will
  287.    look like the following:
  288.  
  289.    ------------------------------------------------------------------------
  290.  
  291.    ╔═══════════════════════════════════════════╗
  292.    ║          >>>>>>> SFCOMTRV <<<<<<<         ║
  293.    ║                Release 2.5                ║
  294.    ║   Computerese Trivia  For SPITFIRE Doors  ║
  295.    ║      Freeware from NEWS CARRIER BBS       ║
  296.    ║In co-operation with Buffalo Creek Software║
  297.    ║             All Rights Reserved           ║
  298.    ║   Copyright (C) by Bernard King, 1989, 90 ║
  299.    ╚═══════════════════════════════════════════╝
  300.    RIGHT: 0                        WRONG: 0
  301.  
  302.    QUESTION:
  303.    The assorted trivia questions will be displayed
  304.    here.
  305.  
  306.    <1> Choice 1                        <2> Choice 2
  307.    <3> Choice 3                        <4> Choice 4
  308.  
  309.              Enter Answer: [ 1 2 3 4 <Q>uit]?
  310.  
  311.    -----------------------------------------------------------------------
  312.  
  313.    The first randomly choosen trivia question is selected from the data
  314.    file and is displayed to the screen.
  315.  
  316.       The player makes his selection by entering the corresponding number.
  317.    As the game progresses, SFCOMTRV will provide a running total of the
  318.    correct answers and also of the wrong answers the user has selected
  319.    during the game play.
  320.  
  321.    If your response  time  should elapse before you respond, SFCOMTRV
  322.    will count this as a wrong response and add an incorrect answer to
  323.    the total WRONG answers obtained so far.
  324.  
  325.  
  326.    EXITING PLAY
  327.    ------------
  328.  
  329.       When you are ready to exit the game, simply select press "Q" for
  330.    <Q>uit.  If you qualify as one of the top ten players to date,
  331.    SFCOMTRV will congratulate you for becoming one of the top ten scorers
  332.    and add your name to the Top Ten listing.  You will once again see the
  333.    Top Ten list displayed with your name added to the list.
  334.  
  335.       If you exit the game before you have completed the twenty
  336.    questions required for eligibility to the Top Ten list or if you do not
  337.    qualify as a Top Ten player, the Top Ten listing will be displayed and 
  338.    you will be prompted to press any key to return to SPITFIRE.
  339.  
  340.  
  341.    DISTRIBUTION
  342.    ------------
  343.  
  344.       Please feel free to share SFCOMTRV.ZIP with others.  However, it must
  345.    be distributed with SFCOMTRV.EXE, SFCOMTRV.DAT, SFCOMTRV.TOP, SFCOMTRV.LMT
  346.    and SFCOMTRV.DOC in the distribution package.  These files must
  347.    not be altered in any way, shape or form.
  348.  
  349.  
  350.    PUBLIC DOMAIN - DISCLAIMER
  351.    --------------------------
  352.  
  353.       SFCOMTRV is distributed under the public domain concept. The software
  354.    and its accompanying documentation are provided "as is" without warranties
  355.    expressed or implied as to the performance or merchantability. No regis-
  356.    tration fee is required and the program can be distributed freely. How-
  357.    ever, by the use of SFCOMTRV, the user assumes all responsibilities and
  358.    agrees that Bernard King shall not be held liable for any damage incurred
  359.    to hardware, software or peripheral devices while running same.
  360.  
  361.       Many thanks are indeed owed to Mike Woltz Sysop of Buffalo Creek BBS
  362.    (515)-225-8496 and author of SPITFIRE whose ingenious talent provided
  363.    the ENGINE for this CAR.
  364.  
  365.  
  366.    History
  367.    -------
  368.  
  369.    Release 1    Sfcomtrv set free.
  370.  
  371.    Release 2    Added file sharing and locking capabilities for smooth
  372.                 operation under a multi-node environment.
  373.  
  374.    Release 2.5  Added the /D command line parameter which allows the
  375.                 Sysop to configure the delay time in seconds that a
  376.                 user is allowed before the question times out. Defaults
  377.                 to ten seconds if not used.
  378.  
  379.                 Added ASYNC routines for high speed modems with the
  380.                 16450 or 16550 UART chip.
  381.  
  382.  
  383.    SFCOMTRV and other SPITFIRE programs are available for download from:
  384.  
  385.         Buffalo Creek BBS                     The Mother Board BBS
  386.         Sysop - Mike Woltz                   Sysop - Jacque Shipley
  387.           (515) 225-8496                         (515) 986-3445
  388.     38400/19200/9600/2400/1200                   9600/2400/1200
  389.  
  390.                                NEWS CARRIER BBS
  391.                              Sysop - Bernard King
  392.                                 (416) 291-4903
  393.                              19200/9600/2400/1200
  394.